Tootsville::Item-Template-Info

Function

Item-Template-Info names a function, with lambda list (TEMPLATE):

Provides a JSON structure describing the item TEMPLATE given.

This structure has the following keys:

id
The unique ID (integer) of this item template

name
The unique name of this item template. This may be user-visible.

description
A description, which may be surfaced to the user, of this item.

trade
This is one of the following values (case-insensitive):

Y
Yes, this item can be traded (given away or dropped).

N
No, this item cannot be traded (given away or dropped).

X
As N, but also, this item should not be visible to the player holding it (e.g. in inventory). This code represents the value “hidden”.

avatar
The item avatar (model) representing this item.

energyKind
The kind of energy (if any) used by this item. Values may be “null,” if the item does not consume any particular kind of energy, or COUNTABLE if the item uses a form of energy that is counted in discrete units, or UNCOUNTABLE if the item's energy is recorded as a fluid percentage of its maximum value. This should be used by the client to provide either a counter, a gauge (meter), or no affordance indicating the energy level, as appropriate.

energyMax
The maximum amount of energy that this kind of item can possess.

onZero
When this item's energy reaches zero, does it VANISH from the game, or remain EMPTY awaiting a refill?

gauge
Linked to energyKind, should a guage or counter be displayed? True for EnergyKind of COUNTABLE or UNCOUNTABLE, false for null.

wearSlot
The ID of the wearable item slot into which this item can be equipped, if any.

weight
The weight of instances of this template

File

Defined in file src/items.lisp.